curl --request GET \
--url https://api.example.com/agent/schemaimport requests
url = "https://api.example.com/agent/schema"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/agent/schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/agent/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/agent/schema"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/agent/schema")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/agent/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"identity": {},
"context_config": {},
"react_config": {}
}[Deprecated] Legacy sectioned schema — use /schema/v2
Return the legacy sectioned JSON Schema fragments.
.. deprecated::
Superseded by :func:get_agent_schema_v2, which returns the
full :class:AgentData schema in a single schema field.
Kept for backwards compatibility with existing API consumers.
New consumers should call GET /agent/schema/v2.
The frontend previously used three sections — identity, context
config, and react config — so we return them as separate
self-contained schemas rather than a single :class:AgentData
schema with $ref s.
Returns:
AgentSchemaResponse:
Schemas for the three form sections.
curl --request GET \
--url https://api.example.com/agent/schemaimport requests
url = "https://api.example.com/agent/schema"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/agent/schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/agent/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/agent/schema"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/agent/schema")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/agent/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"identity": {},
"context_config": {},
"react_config": {}
}Response
Successful Response
Deprecated. JSON Schema fragments used by the frontend to render the agent create / edit forms.
Superseded by :class:AgentSchemaV2Response, which returns the full
:class:AgentData JSON Schema in a single schema field so newly
added agent fields (like the invite_config sub-model) reach the
frontend automatically without the router having to know about them.
The frontend previously split :class:AgentData into three
hand-picked sections (identity, context_config,
react_config) here, which required a router edit every time a
new user-editable field landed on :class:AgentData. Kept for
backwards compatibility with pre-v2 API consumers.